Layout configuration options
When you select the canvas of your dashboard, you can change many of the dashboard layout settings in the visual editor Configuration panel.
Layout options
Some of the following options are available through the visual editor and others are available only using the options
level of the layout section of the dashboard definition.
Option | Type | Default | Description |
---|---|---|---|
backgroundColor | string | lightmode: #FFFFFF darkmode: #FF0000 Splunk Cloud Platform: #171D21
|
Specify the color of the layout background color using a hexadecimal code, such as #FF0000 .
|
display | auto , actual-size , or fit-to-width
|
auto
|
Specify the display behavior. If this property is set to actual-size , changing the size of your browser doesn't change the size of your dashboard or visualizations. If this property is set to auto , your dashboard and visualizations automatically also change size.
|
submitButton | Boolean | false | You can specify the layout option submitButton . When set to true , a user must select a Submit button for the input selection to take effect. If set to false or not specified at all, the dashboard immediately refreshes when a user makes a selection.
|
submitOnDashboardLoad | Boolean | false | To load the dashboard using the default input values, add the option submitOnDashboardLoad , which will automatically run searches on the first dashboard load. After the initial load, the user must select the Submit button to refresh the dashboard's searches and visualizations. If you don't add SubmitButton then submitOnDashboardLoad doesn't work.
|
backgroundImage | object | n/a | A background image must be one of the following types: JPG, JPEG, PNG, SVG, or GIF. You can also use a web based image using the backgroundImage.src option.
|
backgroundImage.src | SRC | n/a | Specify the location of a background image using the option src. For example: "src": "https://www.myImageLocation.com/galleryX/image1.png" .
|
backgroundImage.w | number | n/a | Specify the image width in pixels for w . Don't specify this option if you set the sizeType option. If you do, it will overrule that setting.
|
backgroundImage.h | number | n/a | Specify the image height in pixels for h . Don't specify this option if you set the sizeType option. If you do, it will overrule that setting.
|
backgroundImage.x | number | (0,y) | Specify the position in pixels of the background image on the x-axis. Don't specify this option if you set the sizeType option. If you do, it will overrule that setting.
|
backgroundImage.y | number | (x,0) | Specify the position in pixels of the background image on the y-axis. Don't specify this option if you set the sizeType option. If you do, it will overrule that setting.
|
backgroundImage.sizeType | auto , contain , or cover
|
contain
|
auto scales the image while maintaining the image proportion. contain increases the size of the image as much as possible without cropping or stretching it. cover increases the size of the image without stretching it. You can crop the image vertically and horizontally to minimize empty space.
|
width | number | 1140 | Specify the canvas width in pixels. The width option only applies to the absolute layout and is unavailable for the grid layout.
|
height | number | 960 | Specify the canvas height in pixels. The height option only applies to the absolute layout and is unavailable for the grid layout.
|
gutterSize | number | 8 | Specify the number representing the size of the gutter between visualizations in pixels. The minimum value is 8, and the maximum value is 16. |
The difference between layout.option and layout.layoutDefinitions
The layout.options
field is where you set your dashboard level settings. The layoutDefinition
field is where you set your tab level settings within a dashboard. If a dashboard has multiple tabs, the layout.layoutDefintions
option sets certain settings instead of the layout.option
option.
The following is a table showing which options apply to layout.option
versus layout.layoutDefinitions
when a dashboard has multiple tabs:
option | layout.option | layout.layoutDefinitions | Notes |
---|---|---|---|
backgroundColor | No | Yes | Applies to absolute layout |
display | No | Yes | Applies to absolute layout |
submitButton | Yes | No | n/a |
submitOnDashboardLoad | Yes | No | n/a |
backgroundImage | No | Yes | Applies to absolute layout |
backgroundImage.src | No | No | n/a |
backgroundImage.q | No | No | n/a |
backgroundImage.h | No | No | n/a |
backgroundImage.x | No | No | n/a |
backgroundImage.y | No | No | n/a |
backgroundImage.sizeType | No | No | n/a |
width | No | Yes | Applies to absolute layout |
height | No | Yes | Applies to absolute layout |
gutterSize | No | Yes | Applies to grid layout |
Input configuration options |
This documentation applies to the following versions of Splunk Cloud Platform™: 9.2.2406 (latest FedRAMP release)
Feedback submitted, thanks!